From 5e4c73ceeb0d196dd79b3bb4e000cf0bcc25f2d7 Mon Sep 17 00:00:00 2001 From: parkrrrr Date: Thu, 18 May 2006 15:52:31 +0000 Subject: [PATCH] More doc updates --- xmldoc/chapters/_chapters.xml | 1 + xmldoc/chapters/allchapters.xml | 1 + xmldoc/chapters/datums.xml | 138 ++++++++++++++++++++ xmldoc/formats/garmin_txt.xml | 43 +++--- xmldoc/formats/mapsource.xml | 3 +- xmldoc/formats/options/garmin_txt-date.xml | 5 +- xmldoc/formats/options/garmin_txt-datum.xml | 5 +- xmldoc/formats/options/garmin_txt-dist.xml | 6 +- xmldoc/formats/options/garmin_txt-prec.xml | 6 +- xmldoc/formats/options/garmin_txt-temp.xml | 5 +- xmldoc/formats/options/garmin_txt-time.xml | 5 +- xmldoc/formats/options/garmin_txt-utc.xml | 6 +- xmldoc/formats/options/ignrando-index.xml | 4 +- xmldoc/formats/options/stmwpp-index.xml | 4 +- 14 files changed, 192 insertions(+), 40 deletions(-) create mode 100644 xmldoc/chapters/datums.xml diff --git a/xmldoc/chapters/_chapters.xml b/xmldoc/chapters/_chapters.xml index 9b75d3d63..6ce0611e4 100644 --- a/xmldoc/chapters/_chapters.xml +++ b/xmldoc/chapters/_chapters.xml @@ -4,3 +4,4 @@ + diff --git a/xmldoc/chapters/allchapters.xml b/xmldoc/chapters/allchapters.xml index 79e457686..bffbe70e8 100644 --- a/xmldoc/chapters/allchapters.xml +++ b/xmldoc/chapters/allchapters.xml @@ -3,3 +3,4 @@ &chap_use; &chap_formats; &chap_filters; +&app_datums; diff --git a/xmldoc/chapters/datums.xml b/xmldoc/chapters/datums.xml new file mode 100644 index 000000000..3bc474445 --- /dev/null +++ b/xmldoc/chapters/datums.xml @@ -0,0 +1,138 @@ + +Supported Datums + +Some formats in GPSBabel support multiple datums. For example, the + option to the +garmin_txt format allows you to specify +a datum for the output file. + + +The following is a list of the datums supported by GPSBabel. + + + +Adindan +AFG +Ain-El-Abd +Alaska-NAD27 +Alaska-Canada +Anna-1-Astro +ARC 1950 Mean +ARC 1960 Mean +Asc Island 58 +Astro B4 +Astro Beacon E +Astro pos 71/4 +Astro stn 52 +Australia Geo 1984 +Bahamas NAD27 +Bellevue IGN +Bermuda 1957 +Bukit Rimpah +Camp_Area_Astro +Campo_Inchauspe +Canada_Mean(NAD27) +Canal_Zone_(NAD27) +Canton_Island_1966 +Cape +Cape_Canaveral_mean +Carribean NAD27 +Carthage +Cent America NAD27 +Chatham 1971 +Chua Astro +Corrego Alegre +Cuba NAD27 +Cyprus +Djakarta(Batavia) +DOS 1968 +Easter lsland 1967 +Egypt +European 1950 +European 1950 mean +European 1979 mean +Finnish Nautical +Gandajika Base +Geodetic Datum 49 +Ghana +Greenland NAD27 +Guam 1963 +Gunung Segara +Gunung Serindung 1962 +GUX1 Astro +Herat North +Hjorsey 1955 +Hong Kong 1963 +Hu-Tzu-Shan +Indian +Iran +Ireland 1965 +ISTS 073 Astro 69 +Johnston Island 61 +Kandawala +Kerguelen Island +Kertau 48 +L.C. 5 Astro +La Reunion +Liberia 1964 +Luzon +Mahe 1971 +Marco Astro +Masirah Is. Nahrwan +Massawa +Merchich +Mexico NAD27 +Midway Astro 61 +Mindanao +Minna +Montjong Lowe +Nahrwan +Naparima BWI +North America 83 +N. America 1927 mean +Observatorio 1966 +Old Egyptian +Old Hawaiian_mean +Old Hawaiian Kauai +Old Hawaiian Maui +Old Hawaiian Oahu +Oman +OSGB36 +Pico De Las Nieves +Pitcairn Astro 67 +S. Am. 1956 mean(P) +S. Chilean 1963 (P) +Puerto Rico +Pulkovo 1942 +Qornoq +Quatar National +Rome 1940 +S-42(Pulkovo1942) +S.E.Asia_(Indian) +SAD-69/Brazil +Santa Braz +Santo (DOS) +Sapper Hill 43 +Schwarzeck +Sicily +Sierra Leone 1960 +S. Am. 1969 mean +South Asia +Southeast Base +Southwest Base +Tananarive Obs 25 +Thai/Viet (Indian) +Timbalai 1948 +Tokyo mean +Tristan Astro 1968 +United Arab Emirates +Viti Levu 1916 +Wake Eniwetok 60 +WGS 72 +WGS 84 +Yacare +Zanderij +Sweden + + + diff --git a/xmldoc/formats/garmin_txt.xml b/xmldoc/formats/garmin_txt.xml index 6ff12da65..868a97540 100644 --- a/xmldoc/formats/garmin_txt.xml +++ b/xmldoc/formats/garmin_txt.xml @@ -1,36 +1,23 @@ - - - - - garmin_txt is a format that contains nearly all information as in the MapSource main format, GDB. -garmin_txt has some computed values like distances between routepoints and trackpoints, speed, and course (heading) in addition to the standard data fields. - - + +This is a textual format that contains nearly all of the information +contained in the MapSource main format, GDB. +This format also contains some computed values such as distances between +routepoints and trackpoints, speed, and course (heading). + + The main goal of garmin_txt is to make aviation data more available. Because MapSource supports only the export, GPSBabel gives you the possibility to bring aviation data into MapSource. - - + + During the export with MapSource, some fields are written using local settings of MapSource and Windows. These include grid format, gps datum, distance and temperature units, and the representation of date and time fields. GPSBabel tries to read all items automatically. Problems with date and time format can -be solved with the options 'date' and 'time'. - - Options: - - input/output date format (Windows-like. For example "YYYY/MM/DD") - - write coodinates using this (GPSBabel known!) datum - - output unit for distance values, M (=metric, m/km/kph) or S (=statue, ft/mi/mph) - - write coordinates with precision # (# numbers behind dot) - - output unit for temperature values, C (=celsius) or F (=fahrenheit) - - input/output time format (Windows-like For example, "hh:mm:ss xx") - - write timestamps x hours relative to UTC - - Command showing garmin_txt output with all options - gpsbabel -i garmin_txt,date="MM/DD/YYYY",time="hh:mm:ss xx" \ - -f in.txt \ - -o garmin_txt,date="DD.MM.YYYY",datum="WGS 72",dist=m,prec=6,temp=c,time="HH:mm:ss",utc=+2 \ - -F out.txt - - +be solved with the 'date' and 'time' options. + + + Command showing garmin_txt output with all options + gpsbabel -i garmin_txt,date="MM/DD/YYYY",time="hh:mm:ss xx" -f in.txt -o garmin_txt,date="DD.MM.YYYY",datum="WGS 72",dist=m,prec=6,temp=c,time="HH:mm:ss",utc=+2 -F out.txt + diff --git a/xmldoc/formats/mapsource.xml b/xmldoc/formats/mapsource.xml index 31f4319ab..7460e008b 100644 --- a/xmldoc/formats/mapsource.xml +++ b/xmldoc/formats/mapsource.xml @@ -12,13 +12,14 @@ Altitude is supported, but proximity and depth are not. Naming files *.mps will allow file->open in Mapsource to find the files more easily. + Versions 3, 4, and 5 of the Mapsource data format are handled automatically on input. By default the output is version 5. (Until 3/2004, it was version 3, but since Mapsource updates are free, the convenience of having modern icon sets outweighs the backward compatibility concern. Users of other versions can either upgrade or specify the switches to get output in a compatible format.) Waypoints, routes, and tracklogs are -all handled, but maps sets are ignored. +all handled, but map sets are ignored. Information on the Garmin Mapsource format was provided by Ian Cowley and diff --git a/xmldoc/formats/options/garmin_txt-date.xml b/xmldoc/formats/options/garmin_txt-date.xml index 8b1378917..fbaae4b8f 100644 --- a/xmldoc/formats/options/garmin_txt-date.xml +++ b/xmldoc/formats/options/garmin_txt-date.xml @@ -1 +1,4 @@ - + +This options specifies the input and output format for the date. The format +is written similarly to those in Windows. An example format is "YYYY/MM/DD". + diff --git a/xmldoc/formats/options/garmin_txt-datum.xml b/xmldoc/formats/options/garmin_txt-datum.xml index 8b1378917..f31c58d79 100644 --- a/xmldoc/formats/options/garmin_txt-datum.xml +++ b/xmldoc/formats/options/garmin_txt-datum.xml @@ -1 +1,4 @@ - + +This option specifies the datum to be used on output. Valid values for this +option are listed in the appendix. + diff --git a/xmldoc/formats/options/garmin_txt-dist.xml b/xmldoc/formats/options/garmin_txt-dist.xml index 8b1378917..f3a48251e 100644 --- a/xmldoc/formats/options/garmin_txt-dist.xml +++ b/xmldoc/formats/options/garmin_txt-dist.xml @@ -1 +1,5 @@ - + +This option specifies the unit to be used when outputting distance +values. Valid values are M for metric (m/km/kph) or S for statute +(ft/mi/mph). + diff --git a/xmldoc/formats/options/garmin_txt-prec.xml b/xmldoc/formats/options/garmin_txt-prec.xml index 8b1378917..962de067f 100644 --- a/xmldoc/formats/options/garmin_txt-prec.xml +++ b/xmldoc/formats/options/garmin_txt-prec.xml @@ -1 +1,5 @@ - + +This option specifies the precision to be used when writing coordinate values. +Precision is the number of digits after the decimal point. The default +precision is 3. + diff --git a/xmldoc/formats/options/garmin_txt-temp.xml b/xmldoc/formats/options/garmin_txt-temp.xml index 8b1378917..f1de8e27a 100644 --- a/xmldoc/formats/options/garmin_txt-temp.xml +++ b/xmldoc/formats/options/garmin_txt-temp.xml @@ -1 +1,4 @@ - + +This option specifies the unit to be used when writing temperature values. +Valid values are C for Celsius or F for Fahrenheit. + diff --git a/xmldoc/formats/options/garmin_txt-time.xml b/xmldoc/formats/options/garmin_txt-time.xml index 8b1378917..714c7f3ed 100644 --- a/xmldoc/formats/options/garmin_txt-time.xml +++ b/xmldoc/formats/options/garmin_txt-time.xml @@ -1 +1,4 @@ - + +This options specifies the input and output format for the time. The format +is written similarly to those in Windows. An example format is "hh:mm:ss xx". + diff --git a/xmldoc/formats/options/garmin_txt-utc.xml b/xmldoc/formats/options/garmin_txt-utc.xml index 8b1378917..4c2964e0e 100644 --- a/xmldoc/formats/options/garmin_txt-utc.xml +++ b/xmldoc/formats/options/garmin_txt-utc.xml @@ -1 +1,5 @@ - + +This option specifies the local time zone to use when writing times. It +is specified as an offset from Universal Coordinated Time (UTC) in hours. +Valid values are from -23 to +23. + diff --git a/xmldoc/formats/options/ignrando-index.xml b/xmldoc/formats/options/ignrando-index.xml index 714a9c22f..42c8f4e6f 100644 --- a/xmldoc/formats/options/ignrando-index.xml +++ b/xmldoc/formats/options/ignrando-index.xml @@ -1,8 +1,8 @@ -Because the format supports only one track, this option can be used +Because the format supports only one track, this option may be used on output to select a single track from a collection of tracks read from a more expressive format. If you have, say, a -gpx file that contains two tracks, you can +gpx file that contains two tracks, you may use this option to write them one at a time to individual files. gpsbabel -i gpx -f tracks.gpx -o ignrando,index=1 -F track1.txt -o ignrando,index=2 -F track2.txt diff --git a/xmldoc/formats/options/stmwpp-index.xml b/xmldoc/formats/options/stmwpp-index.xml index 3defd318e..6187a66a8 100644 --- a/xmldoc/formats/options/stmwpp-index.xml +++ b/xmldoc/formats/options/stmwpp-index.xml @@ -1,8 +1,8 @@ -Because the format supports only one route or track, this option can be used +Because the format supports only one route or track, this option may be used on output to select a single route or track from a collection of routes and tracks read from a more expressive format. If you have, say, a -gpx file that contains three routes, you can +gpx file that contains three routes, you may use this option to write them one at a time to individual files. gpsbabel -i gpx -f routes.gpx -o stmwpp,index=1 -F route1.txt -o stmwpp,index=2 -F route2.txt -o stmwpp,index=3 -F route3.txt -- 2.30.2